build: align ZITADEL Preview release channel - #264
Closed
fforootd wants to merge 5 commits into
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the repository’s “public preview” distribution around a single preview npm dist-tag, lockstep package versions, and ZITADEL Preview GitHub Releases, while updating the CLI, docs, CI, and consumer-journey flow to use the new naming and immutable version→image mapping.
Changes:
- Switch prerelease publishing from
@...@alphato@...@preview(keeping-alpha.Nversions) and configure Changesets to keep the public preview packages in a fixed version group. - Rename/alias the server image/release artifacts to
ghcr.io/zitadel/zitadel-previewandZITADEL Preview …, and add automation to verify preview release consistency plus cleanup helpers for old package-level GitHub Releases. - Update CLI logic + tests to (a) suggest
@previewcommands, (b) default the local runtime image toghcr.io/zitadel/zitadel-preview:<cli-version|preview>, and (c) scaffold framework deps using bundled versions instead of dist-tags.
Reviewed changes
Copilot reviewed 47 out of 47 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/verify-preview-release.mjs | New release verification script to enforce lockstep public package versions + expected GoReleaser config. |
| scripts/delete-package-github-releases.mjs | New helper to remove legacy @zitadel/* GitHub Releases via gh CLI (dry-run by default). |
| scripts/check.mjs | Extend pack/build checks to include additional public preview SDK packages. |
| scripts/check-changeset-required.mjs | Treat additional SDK packages as publishable roots requiring changesets. |
| README.md | Update quickstart and release docs to use @preview and ghcr.io/zitadel/zitadel-preview. |
| docs/quick-start/index.md | Update CLI commands to use @preview. |
| docs/quick-start/docker-compose.md | Update default image reference to ghcr.io/zitadel/zitadel-preview:preview and document aliasing. |
| docs/operations/env.example | Update default NEXTGEN_IMAGE to ghcr.io/zitadel/zitadel-preview:preview. |
| docs/operations/docker-compose.yaml | Update default compose image to ghcr.io/zitadel/zitadel-preview:preview. |
| docs/adrs/002-multi-package-release-strategy.md | Update ADR to reflect preview bundle contract, naming, and verification/cleanup steps. |
| CONTRIBUTING.md | Update contributor command examples to @preview. |
| apps/cli/tests/unit/lib/public-cli.test.ts | Update expectations for preview dist-tag command rendering. |
| apps/cli/tests/unit/lib/orca/patchers/rule/next/index.test.ts | Update Next patcher expectations to use bundled/exact versions and add fallback coverage. |
| apps/cli/tests/unit/lib/local-server/runtime.test.ts | Add unit coverage for deriving preview image tag from CLI version. |
| apps/cli/tests/unit/commands/status.test.ts | Update suggested next commands to use @preview. |
| apps/cli/tests/unit/commands/local-runtime.test.ts | Update runtime command tests for preview image defaults and @preview next commands. |
| apps/cli/tests/integration/setup-next.test.ts | Update integration test to assert exact bundled SDK version is scaffolded. |
| apps/cli/tests/integration/contract.test.ts | Update envelope contract test for @preview next commands. |
| apps/cli/src/lib/versions.ts | New centralized version/tag/image helpers and dependency version resolution. |
| apps/cli/src/lib/public-cli.ts | Route dist-tag selection through shared version helper. |
| apps/cli/src/lib/orca/patchers/types.ts | Extend patch context with optional dependency version overrides. |
| apps/cli/src/lib/orca/patchers/rule/next/index.ts | Use bundled/exact versions for SDK deps (with fallbacks) instead of prerelease tag inference. |
| apps/cli/src/lib/local-server/runtime.ts | Replace constant default image with version-derived preview image helper. |
| apps/cli/src/commands/start.ts | Default local runtime image to ghcr.io/zitadel/zitadel-preview:<derived> based on CLI version. |
| apps/cli/src/commands/setup/index.ts | Provide resolved dependency versions into patch context for deterministic scaffolding. |
| apps/cli/src/commands/doctor/patch-context.ts | Thread dependency versions into patch context loader. |
| apps/cli/src/commands/doctor/index.ts | Default doctor’s image selection to version-derived preview image and populate dependency versions. |
| apps/cli/src/commands/doctor/checks/types.ts | Extend doctor check context with dependency version metadata. |
| apps/cli/src/commands/doctor/checks/dependency.ts | Pass dependency versions into patch context for repairs. |
| apps/cli/SKILLS.md | Update agent-facing CLI contract examples to @preview. |
| apps/cli/README.md | Update CLI docs to @preview and explain image mapping to CLI version. |
| apps/cli-journey-e2e/scripts/verify-tarballs.mjs | Include additional public preview SDK packages in tarball verification. |
| apps/cli-journey-e2e/scripts/run-local.mjs | Include additional public preview SDK packages in local journey flow. |
| apps/cli-journey-e2e/scripts/publish-tarballs.mjs | Publish tarballs under preview only (drop alpha/latest tagging in journey registry). |
| apps/cli-journey-e2e/scripts/prepare-next-app.mjs | Run setup via @preview and assert scaffolded SDK version matches workspace version. |
| apps/cli-journey-e2e/README.md | Update journey documentation to preview bundle and preview tag flow. |
| apps/cli-journey-e2e/AGENTS.md | Update agent guidance for journey artifacts to include the expanded public preview package set. |
| AGENTS.md | Update repo-wide agent guidance to @preview commands and expanded public package set. |
| .goreleaser.yaml | Rename archives/releases to zitadel-preview_* / ZITADEL Preview … and publish preview tag (plus temporary nextgen image alias). |
| .github/workflows/release.yml | Add a verification step for preview bundle versions before publishing. |
| .github/workflows/release-npm.yml | Publish via Changesets under preview dist-tag and disable package-level GitHub Releases. |
| .github/workflows/ci.yml | Update CI snapshot image discovery/tagging and include additional packages in pack artifacts. |
| .github/instructions/release-docs.instructions.md | Update doc-writing guidance to prefer @preview and ghcr.io/zitadel/zitadel-preview. |
| .github/instructions/consumer-journey.instructions.md | Update consumer-journey guidance to use the preview package set and preview tag. |
| .changeset/README.md | Document “alpha versions, preview channel” and fixed preview bundle behavior. |
| .changeset/preview-bundle-channel.md | Add a changeset for the preview channel + naming alignment. |
| .changeset/config.json | Configure Changesets fixed group for the public preview packages to enforce lockstep versions. |
fforootd
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
previewnpm publishing, fixed lockstep versions, andZITADEL PreviewGitHub ReleasesTesting
corepack pnpm nx test @zitadel/clicorepack pnpm nx typecheck @zitadel/clicorepack pnpm run journeycorepack pnpm changeset status --verbosegit diff --check